<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>2.2. odtone::mih::message_helper Class Reference</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="ODTONE 0.3">
<link rel="up" href="../index_mih.html" title="ODTONE MIH">
<link rel="prev" href="odtone_mih_message_class.html" title="2.1. odtone::mih::message Class Reference">
<link rel="next" href="odtone_mih_indication_class.html" title="2.3. odtone::mih::indication Class Reference">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="'ODTONE - Open Dot Twenty One'" width="100" height="100" src="../../.././images/logo.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="odtone_mih_message_class.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index_mih.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="odtone_mih_indication_class.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
<div class="section" title="2.2. odtone::mih::message_helper Class Reference">
<div class="titlepage"><div><div><h4 class="title">
<a name="odtone.library.index_mih.odtone_mih_message_helper_class"></a><a class="link" href="odtone_mih_message_helper_class.html" title="2.2. odtone::mih::message_helper Class Reference">
        2.2. odtone::mih::message_helper Class Reference</a>
</h4></div></div></div>
<a name="odtone.library.index_mih.odtone_mih_message_helper_class.detailed_description"></a><h6>
<a name="id3057909"></a>
          <a class="link" href="odtone_mih_message_helper_class.html#odtone.library.index_mih.odtone_mih_message_helper_class.detailed_description">Detailed
          Description</a>
        </h6>
<p>
          <span class="inlinemediaobject"><img src="./../../../images/odtone::mih::message_helper.png" alt="odtone::mih::message_helper"></span>
        </p>
<p>
          <span class="bold"><strong>MIH Message helper.</strong></span>
        </p>
<p>
          Parsing/Generating MIH messages is done with helper classes (<a class="link" href="odtone_mih_request_class.html" title="2.4. odtone::mih::request Class Reference">odtone::mih::request</a>,
          <a class="link" href="odtone_mih_response_class.html" title="2.5. odtone::mih::response Class Reference">odtone::mih::response</a>,
          <a class="link" href="odtone_mih_indication_class.html" title="2.3. odtone::mih::indication Class Reference">odtone::mih::indication</a>,
          <a class="link" href="odtone_mih_confirm_class.html" title="2.5. odtone::mih::confirm Class Reference">odtone::mih::confirm</a>)
          and operator overloading.
        </p>
<p>
          This will be the base class to <a class="link" href="odtone_mih_request_class.html" title="2.4. odtone::mih::request Class Reference">odtone::mih::request</a>,
          <a class="link" href="odtone_mih_response_class.html" title="2.5. odtone::mih::response Class Reference">odtone::mih::response</a>,
          <a class="link" href="odtone_mih_indication_class.html" title="2.3. odtone::mih::indication Class Reference">odtone::mih::indication</a>
          and <a class="link" href="odtone_mih_confirm_class.html" title="2.5. odtone::mih::confirm Class Reference">odtone::mih::confirm</a>
          as is documented later in this document.
        </p>
<p>
          This class derive from boost::noncopyable in order to prohibit copy construction
          and copy assignment. Thus, <a class="link" href="odtone_mih_message_helper_class.html" title="2.2. odtone::mih::message_helper Class Reference">odtone::mih::message_helper</a>
          class has protected constructor and destructor members and should be used
          only as a base class.
        </p>
<a name="odtone.library.index_mih.odtone_mih_message_helper_class.namespace"></a><h6>
<a name="id3058054"></a>
          <a class="link" href="odtone_mih_message_helper_class.html#odtone.library.index_mih.odtone_mih_message_helper_class.namespace">Namespace</a>
        </h6>
<p>
          
</p>
<pre class="programlisting"><span class="keyword">namespace</span> <span class="identifier">odtone</span><span class="special">::</span><span class="identifier">mih</span>
</pre>
<p>
        </p>
<a name="odtone.library.index_mih.odtone_mih_message_helper_class.public_member_functions"></a><h6>
<a name="id3058107"></a>
          <a class="link" href="odtone_mih_message_helper_class.html#odtone.library.index_mih.odtone_mih_message_helper_class.public_member_functions">Public
          Member Functions</a>
        </h6>
<p>
          
</p>
<pre class="programlisting"><span class="identifier">message_helper</span><span class="special">(</span><span class="identifier">uint16</span> <span class="identifier">mid</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">id</span><span class="special">*</span> <span class="identifier">dst</span><span class="special">);</span>

<span class="keyword">friend</span> <span class="identifier">oarchive</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">message</span><span class="special">&amp;</span> <span class="identifier">msg</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">message_helper</span><span class="special">&amp;</span> <span class="identifier">mh</span><span class="special">);</span>
<span class="keyword">friend</span> <span class="identifier">iarchive</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&gt;&gt;(</span><span class="identifier">message</span><span class="special">&amp;</span> <span class="identifier">msg</span><span class="special">,</span> <span class="keyword">const</span> <span class="identifier">message_helper</span><span class="special">&amp;</span> <span class="identifier">mh</span><span class="special">);</span>
</pre>
<p>
        </p>
<p>
          <span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span>
        </p>
<a name="odtone.library.index_mih.odtone_mih_message_helper_class.constructor__amp__destructor_documentation"></a><h6>
<a name="id3058454"></a>
          <a class="link" href="odtone_mih_message_helper_class.html#odtone.library.index_mih.odtone_mih_message_helper_class.constructor__amp__destructor_documentation">Constructor
          &amp; Destructor Documentation</a>
        </h6>
<p>
          
</p>
<pre class="programlisting"><span class="identifier">message_helper</span><span class="special">(</span><span class="identifier">uint16</span> <span class="identifier">mid</span><span class="special">,</span>
               <span class="keyword">const</span> <span class="identifier">id</span><span class="special">*</span> <span class="identifier">dst</span><span class="special">);</span>
</pre>
<p>
          Construct a MIH Message helper.
        </p>
<p>
          <span class="bold"><strong>Parameters:</strong></span>
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>mid</strong></span> - value of MIH Message ID.
          </li>
<li class="listitem">
<span class="bold"><strong>dst</strong></span> - MIH Message Destination MIHF ID.
          </li>
</ul></div>
<a name="odtone.library.index_mih.odtone_mih_message_helper_class.member_function_documentation"></a><h6>
<a name="id3058572"></a>
          <a class="link" href="odtone_mih_message_helper_class.html#odtone.library.index_mih.odtone_mih_message_helper_class.member_function_documentation">Member
          Function Documentation</a>
        </h6>
<p>
          
</p>
<pre class="programlisting"><span class="keyword">friend</span> <span class="identifier">oarchive</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&lt;&lt;(</span><span class="identifier">message</span><span class="special">&amp;</span> <span class="identifier">msg</span><span class="special">,</span>
                            <span class="keyword">const</span> <span class="identifier">message_helper</span><span class="special">&amp;</span> <span class="identifier">mh</span><span class="special">);</span>
</pre>
<p>
        </p>
<p>
          Serialize fields of the MIH Message.
        </p>
<p>
          <span class="bold"><strong>Parameters:</strong></span>
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>msg</strong></span> - msg destination <a class="link" href="odtone_mih_message_class.html" title="2.1. odtone::mih::message Class Reference">odtone::mih::message</a>.
          </li>
<li class="listitem">
<span class="bold"><strong>mh</strong></span> - message helper.
          </li>
</ul></div>
<p>
          <span class="bold"><strong>Return</strong></span>
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
            Output archive (<a class="link" href="odtone_mih_oarchive_class.html" title="2.10. odtone::mih::oarchive Class Reference">odtone::mih::oarchive</a>).
          </li></ul></div>
<p>
          <span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span><span class="underline">_</span>
        </p>
<p>
          
</p>
<pre class="programlisting"><span class="keyword">friend</span> <span class="identifier">iarchive</span><span class="special">&amp;</span> <span class="keyword">operator</span><span class="special">&gt;&gt;(</span><span class="identifier">message</span><span class="special">&amp;</span> <span class="identifier">msg</span><span class="special">,</span>
                            <span class="keyword">const</span> <span class="identifier">message_helper</span><span class="special">&amp;</span> <span class="identifier">mh</span><span class="special">);</span>
</pre>
<p>
        </p>
<p>
          Deserialize fields from a MIH Message.
        </p>
<p>
          <span class="bold"><strong>Parameters:</strong></span>
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<span class="bold"><strong>msg</strong></span> - msg destination <a class="link" href="odtone_mih_message_class.html" title="2.1. odtone::mih::message Class Reference">odtone::mih::message</a>.
          </li>
<li class="listitem">
<span class="bold"><strong>mh</strong></span> - message helper.
          </li>
</ul></div>
<p>
          <span class="bold"><strong>Return</strong></span>
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
            Input archive (<a class="link" href="odtone_mih_iarchive_class.html" title="2.9. odtone::mih::iarchive Class Reference">odtone::mih::iarchive</a>).
          </li></ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2009 -2011 Universidade Aveiro<br>Copyright &#169; 2009 -2011 Instituto de Telecomunica&#231;&#245;es - P&#243;lo Aveiro<p>
        This software is distributed under a license. The full license agreement
        can be found in the LICENSE in this distribution. This software may not be
        copied, modified, sold or distributed other than expressed in the named license
        agreement. This software is distributed without any warranty.
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="odtone_mih_message_class.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index_mih.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="odtone_mih_indication_class.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
</div>
</body>
</html>
